Appliance Recovery Backup Job Details Info
The Appliance Recovery Backup Job Details Info schema contains information about a backup job.
This schema was added in vSphere API 6.7.
{
"location": "string",
"duration": 0,
"size": 0,
"progress": {
"total": 0,
"completed": 0,
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
},
"location_user": "string",
"type": "string",
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"build": {
"version_name": "string",
"version": "string",
"build_number": "string"
},
"fast_backup": false,
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"service": "string",
"operation": "string",
"parent": "string",
"target": {
"type": "string",
"id": "string"
},
"status": "string",
"cancelable": false,
"error": {},
"start_time": "string",
"end_time": "string",
"user": "string"
}
URL of the backup location.
This property was added in vSphere API 6.7.
Time in seconds since the backup job was started or the time it took to complete the backup job.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of CommonInfo#status is one of Cis Task Status.SUCCEEDED, Cis Task Status.FAILED, or Cis Task Status.RUNNING.
Size of the backup data transferred to remote location.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of CommonInfo#status is one of Cis Task Status.SUCCEEDED, Cis Task Status.FAILED, or Cis Task Status.RUNNING.
Progress of the job.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of CommonInfo#status is one of Cis Task Status.SUCCEEDED, Cis Task Status.FAILED, or Cis Task Status.RUNNING.
The username for the remote backup location.
This property was added in vSphere API 6.7.
Type of the backup job. Indicates whether the backup was started manually or as a scheduled backup.
For more information see: Appliance Recovery Backup Job Details Type.
This property was added in vSphere API 6.7.
List of any info/warning/error messages returned by the backup job.
This property was added in vSphere API 6.7.
Information about the build of the appliance.
This property was added in vSphere API 6.7.2.
This property is optional because it was added in a newer version than its parent node.
Option to enable Postgres DB/ VCDB fast backup
This property was added in vSphere API 6.7.
Description of the operation associated with the task.
This property was added in vSphere API 6.7.
Identifier of the service containing the operation.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service
.
Identifier of the operation associated with the task.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation
.
Parent of the current task.
This property was added in vSphere API 6.7.
This property will be missing or null
if the task has no parent.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.task
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.task
.
Identifier of the target created by the operation or an existing one the operation performed on.
This property was added in vSphere API 6.7.
This property will be missing or null
if the operation has no target or multiple targets.
Status of the operation associated with the task.
For more information see: Cis Task Status.
This property was added in vSphere API 6.7.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
This property was added in vSphere API 6.7.
Description of the error if the operation status is "FAILED".
This property was added in vSphere API 6.7.
If missing or null
the description of why the operation failed will be included in the result of the operation (see Cis Task Info.result).
Time when the operation is started.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Time when the operation is completed.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.SUCCEEDED or Cis Task Status.FAILED.
Name of the user who performed the operation.
This property was added in vSphere API 6.7.
This property will be missing or null
if the operation is performed by the system.